docs: inline ndarray output in doctests and add missing article#11557
Merged
docs: inline ndarray output in doctests and add missing article#11557
Conversation
…escriptions
Propagates fix from d4c1b8b1a ("test: update description") and b8ad692
("test: update description") to sibling axpy packages — inserting missing
"a " before "one-dimensional ndarray `x`" and "one-dimensional ndarray `y`"
in the top-level tape() description. Affects `gaxpy`, `saxpy`, `daxpy`.
https://claude.ai/code/session_01GXZT2uLjX36Q2EepAt4GeQ
… and `blas/ext/base/ndarray/*` Propagates fix from 7be0aa6, a6b67f6, 71a93c8, adc6eb6, d5dc0ec, 9e562a3, a19ed4c, 00385f6 ("docs: improve doctests for ndarray instances in ..."), and 849495e ("docs: update example") to sibling ndarray-instance packages — removing the `ndarray2array` import plus the trailing `var arr = ndarray2array( v )` block and inlining the array value into the `// returns <ndarray>[...]` comment. Applied to: - stats/base/ndarray: scumaxabs, scuminabs, plus 10 `@example` blocks in stats/base/ndarray/docs/types/index.d.ts (cumax, cumin, dcumax, dcumaxabs, dcumin, dcuminabs, scumax, scumaxabs, scumin, scuminabs). - blas/ext/base/ndarray: dcusumkbn (main.js only), dsortins, dsortsh, gcusumkbn, gcusumkbn2, gcusumors, gcusumpw, glinspace, gsorthp, scusumkbn, scusumkbn2, scusumors, slinspace, ssorthp, plus 13 `@example` blocks in blas/ext/base/ndarray/docs/types/index.d.ts (dsortins, dsortsh, gcusumkbn, gcusumkbn2, gcusumors, gcusumpw, glinspace, gsorthp, scusumkbn, scusumkbn2, scusumors, slinspace, ssorthp). The `Examples` section of each README (runnable `console.log` blocks) is intentionally untouched; the fix only applies to the Usage doctest blocks. https://claude.ai/code/session_01GXZT2uLjX36Q2EepAt4GeQ
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Planeshifter
changed the title
docs / test fixes across sibling ndarray packagesstats/base/ndarray/* and blas/ext/base/ndarray/*
Planeshifter
changed the title
stats/base/ndarray/* and blas/ext/base/ndarray/*ndarray packages
kgryte
added
the
bot: Merge
stdlib-bot
added
bot: In Progress
…agation-2026-04-18
Planeshifter
changed the title
ndarray packages
kgryte
removed
the
bot: In Progress
Member
|
/stdlib merge |
stdlib-bot
added
the
bot: In Progress
…agation-2026-04-18
stdlib-bot
removed
the
bot: In Progress
Member
|
/stdlib merge |
stdlib-bot
added
the
bot: In Progress
…agation-2026-04-18
stdlib-bot
removed
the
bot: In Progress
kgryte
approved these changes
Apr 19, 2026
Member
|
As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Propagates two fixes from
develop(window:3af178cc0→414d61b8a) to sibling packages with the same defect.7be0aa66fet al. — inline ndarray output in doctests. Drops the@stdlib/ndarray/to-arrayrequire and trailingvar arr = ndarray2array( v )block; folds the value into// returns <ndarray>[...]. Applied tostats/base/ndarray/{scumaxabs,scuminabs},blas/ext/base/ndarray/{dcusumkbn,dsortins,dsortsh,gcusumkbn,gcusumkbn2,gcusumors,gcusumpw,glinspace,gsorthp,scusumkbn,scusumkbn2,scusumors,slinspace,ssorthp}, and the two namespaceindex.d.tsfiles (10 + 13@exampleblocks). Runnable## Examplesblocks left untouched.d4c1b8b1a/b8ad692ed— missing article in*axpytest description. "one-dimensional ndarrayx" → "a one-dimensional ndarrayx" (and same fory) inblas/base/ndarray/{gaxpy,saxpy,daxpy}/test/test.js.Related Issues
No.
Questions
No.
Other
Excluded:
850600f45(BigInt note innapi/argv-*) and3af178cc0(backtick requires) — both already fully propagated; namespace TOC / related-packages updates — not generalizable.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
Authored by Claude Code as an automated fix-propagation routine.
@stdlib-js/reviewers